Skip to content

docs(codex): distribution + install guide (M6, SIG-174)#172

Draft
GuyMoses wants to merge 2 commits into
mainfrom
sig-174-m6-distribution-release-strategy-codex
Draft

docs(codex): distribution + install guide (M6, SIG-174)#172
GuyMoses wants to merge 2 commits into
mainfrom
sig-174-m6-distribution-release-strategy-codex

Conversation

@GuyMoses

Copy link
Copy Markdown
Contributor

Closes SIG-174.

Documents the Codex distribution/install story, at parity with the Claude Code and Cursor surfaces.

Changes

  • New .codex-plugin/README.md — customer-facing install / upgrade / configuration / privacy defaults / verify / uninstall, mirroring .cursor-plugin/README.md.
  • README.md — Codex added to Supported runtimes and the repository layout table.

Distribution model

  • Primary channel: one-line curl | bash installer (install-codex.sh), which registers hooks as a managed block in ~/.codex/config.toml, fetches the checksum-verified binary from GitHub Releases, and writes credentials to ~/.codex/dash0-agent-plugin.local.md.
  • Upgrade: re-run the installer (re-pins the binary, rewrites the managed block, preserves credentials).

Docs only — no code changes.

Add the Codex runtime README (.codex-plugin/README.md) covering install,
upgrade, configuration, privacy defaults, verification, and uninstall,
mirroring the Cursor surface. List Codex under Supported runtimes and the
repository layout table in the top-level README.

Codex telemetry is distributed via the one-line installer + managed hooks
in ~/.codex/config.toml; GitHub Releases binaries with checksum
verification; upgrade by re-running the installer.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@GuyMoses GuyMoses requested a review from a team as a code owner July 15, 2026 11:44
@GuyMoses GuyMoses marked this pull request as draft July 15, 2026 11:58
- Add a Requirements line (Codex CLI, macOS/Linux).
- Add a Troubleshooting section: start a new session, verify hooks are
  Active via /hooks, and enable the debug log to inspect emitted spans.
- Drop "error status" from the always-collected list (Codex tool error
  status is not emitted yet).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant